Skip to content

gh-98894: fix CheckDtraceProbes tests on Solaris - #154803

Merged
vstinner merged 2 commits into
python:mainfrom
kulikjak:dtrace-probes-fix-list
Oct 17, 2026
Merged

vstinner merged 2 commits into
python:mainfrom
kulikjak:dtrace-probes-fix-list

Conversation

@kulikjak

@kulikjak kulikjak commented Jul 28, 2026 •

Copy link
Copy Markdown
Contributor

Solaris does not use the notes section to list available probes (readelf -n <binary> returns nothing), which makes the test_check_probes fail.

This PR adds a Solaris specific path which gets all the available probes by listing those available in the running test process instead.

The output below is very different so the comparison needs to be updated a little as well.

>>> import subprocess
>>> import os
>>> res = subprocess.run(["dtrace", "-l", "-P", f"python{os.getpid()}"])
   ID   PROVIDER            MODULE                          FUNCTION NAME
   34 python1427 libpython3.16.so.1.0                         sys_audit audit
   35 python1427 libpython3.16.so.1.0           sys_audit_tstate.part.0 audit
   36 python1427 libpython3.16.so.1.0             dtrace_function_entry function-entry
   37 python1427 libpython3.16.so.1.0          _PyEval_EvalFrameDefault function-entry
   38 python1427 libpython3.16.so.1.0            dtrace_function_return function-return
   39 python1427 libpython3.16.so.1.0          _PyEval_EvalFrameDefault function-return
   40 python1427 libpython3.16.so.1.0                   gc_collect_main gc-done
   41 python1427 libpython3.16.so.1.0                   gc_collect_main gc-start
   42 python1427 libpython3.16.so.1.0 import_find_and_load_with_name.isra.0 import-find-load-done
   43 python1427 libpython3.16.so.1.0 import_find_and_load_with_name.isra.0 import-find-load-start

A little unfortunate thing is that the test now requires elevated privileges, but that is true of all other DTrace tests as well, so I don't think that's a big deal.

BTW: there is Solaris specific ELF section for DTrace metadata and at first I wanted to fix the test by reading that one (with readelf -p .SUNW_dof <binary>). Unfortunately, the section includes more metadata than just available probes, and the now removed line probe is also present in the dumped strings (so test_check_probes passes, but test_missing_probes unexpectedly passes as well).

It's possible to use elfdump and do some binary parsing to extract only the available ones, but that is a huge overkill for a test like this. For those interested, the change is here: kulikjak@564e946

@bedevere-app bedevere-app Bot added the tests Tests in the Lib/test dir label Jul 28, 2026

@vstinner vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

I didn't test the change on Solaris, but I trust @kulikjak for that.

@vstinner

Copy link
Copy Markdown
Member

@kulikjak: I pushed a merge commit to your branch to solve a merge conflict.

@vstinner
vstinner enabled auto-merge (squash) October 16, 2026 23:37
@vstinner
vstinner merged commit 967fb3a into python:main Oct 17, 2026
50 checks passed
@miss-islington-app

Copy link
Copy Markdown

Thanks @kulikjak for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14, 3.15.
🐍🍒⛏🤖

@miss-islington-app

Copy link
Copy Markdown

Sorry, @kulikjak and @vstinner, I could not cleanly backport this to 3.14 due to a conflict.

Please backport manually with cherry_picker, see the devguide for more information.

cherry_picker 967fb3afc7e2f706d757925e9346f0bc8aab3c46 3.14

@bedevere-app

bedevere-app Bot commented Oct 17, 2026

Copy link
Copy Markdown

GH-159602 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Oct 17, 2026
vstinner added a commit that referenced this pull request Oct 17, 2026
gh-98894: Fix test_dtrace on Solaris (GH-154803)

Fix 'CheckDtraceProbes' tests by reading available probes from the test process itself.
(cherry picked from commit 967fb3a)

Co-authored-by: Jakub Kulík <Kulikjak@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
vstinner added a commit to vstinner/cpython that referenced this pull request Oct 17, 2026
Fix 'CheckDtraceProbes' tests by reading available probes from the test process itself.

Co-authored-by: Victor Stinner <vstinner@python.org>
(cherry picked from commit 967fb3a)
@bedevere-app

bedevere-app Bot commented Oct 17, 2026

Copy link
Copy Markdown

GH-159605 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Oct 17, 2026
@vstinner

Copy link
Copy Markdown
Member

Merged! Thanks for your fix.

vstinner added a commit that referenced this pull request Oct 17, 2026
gh-98894: Fix test_dtrace on Solaris (#154803)

Fix 'CheckDtraceProbes' tests by reading available probes from the test process itself.


(cherry picked from commit 967fb3a)

Co-authored-by: Jakub Kulík <Kulikjak@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip news tests Tests in the Lib/test dir

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants